package com.thiswhyme.illegalword.core;

import java.util.Set;

/**
 * @description: 敏感词服务
 * @author: thiswhyme
 * @date: 2021/3/30
 */
public interface IllegalWordService {

    /**
     * 校验指定字符串中是否包含敏感词
     * @param txt 指定字符串
     * @param matchType 匹配规则
     * @return 若包含返回true，否则返回false
     */
    boolean isContainsIllegalWord(String txt, MatchType matchType);

    /**
     * 获取指定字符串中包含的敏感词列表
     * @param txt 指定字符串
     * @param matchType 匹配规则
     * @return
     */
    Set<String> getIllegalWords(String txt, MatchType matchType);

    /**
     * 替换指定字符串中的敏感词为指定字符
     * @param txt 指定字符串
     * @param matchType 匹配规则
     * @param replaceChar 替换字符，默认*
     */
    String replaceIllegalWords(String txt, MatchType matchType, String replaceChar);
}
